docs: add AGENTS.MD for AI and developer guidance#7348
docs: add AGENTS.MD for AI and developer guidance#7348JohnMcLear merged 9 commits intoether:developfrom
Conversation
Review Summary by QodoAdd AGENTS.MD guide for AI agents and developers
WalkthroughsDescription• Adds AGENTS.MD guide for AI agents and developers • Documents project overview and technical stack details • Provides directory structure and core development conventions • Includes testing requirements and key architectural concepts Diagramflowchart LR
A["Project Documentation"] -->|"adds new guide"| B["AGENTS.MD"]
B -->|"contains"| C["Project Overview"]
B -->|"contains"| D["Technical Stack"]
B -->|"contains"| E["Development Conventions"]
B -->|"contains"| F["Testing & Validation"]
B -->|"contains"| G["AI-Specific Guidance"]
File Changes1. AGENTS.MD
|
Code Review by Qodo
1. Node engine raised to 20
|
|
/review |
|
Persistent review updated to latest commit 1b656b4 |
|
/review |
|
Persistent review updated to latest commit ec37d5d |
|
/review |
|
Persistent review updated to latest commit 2b36182 |
Review Summary by QodoAdd agent guide and standardize project documentation
WalkthroughsDescription• Add AGENTS.MD guide for AI agents and developers • Standardize indentation to 2 spaces across documentation • Update Node.js version requirement to >=20.0.0 • Enable automatic PR review via .pr_agent.toml configuration Diagramflowchart LR
A["New AGENTS.MD<br/>Agent Guide"] --> B["Documentation<br/>Standards"]
C["PR Agent Config<br/>.pr_agent.toml"] --> D["Automation"]
E["Node.js >=20.0.0<br/>Version Update"] --> F["Dependencies"]
B --> G["Indentation<br/>Standardization"]
G --> H["Updated Files<br/>CONTRIBUTING.md<br/>best_practices.md<br/>README.md"]
File Changes1. AGENTS.MD
|
Code Review by Qodo
1. Docs set HTML 2-space
|
| ### Coding Style | ||
| - **Indentation:** 2 spaces for all files (JS/TS/CSS/HTML). | ||
| - **No Tabs:** Use spaces only. | ||
| - **Comments:** Provide clear comments for complex logic. |
There was a problem hiding this comment.
1. Docs set html 2-space 📘 Rule violation ✓ Correctness
The PR updates contributor/agent guidance to state that HTML should be indented with 2 spaces, which conflicts with the required style rule (HTML must be 4 spaces). This creates non-compliant guidance that will likely lead to future whitespace-style violations.
Agent Prompt
## Issue description
The PR updates documentation to instruct `Indentation: 2 spaces` for everything, including HTML, which conflicts with the required whitespace rule (HTML must be 4 spaces).
## Issue Context
This is a direct mismatch between documented style guidance and the compliance requirement, and will likely cause future diffs and formatting violations.
## Fix Focus Areas
- AGENTS.MD[30-33]
- CONTRIBUTING.md[86-86]
- best_practices.md[86-86]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
This PR adds an AGENTS.MD file to provide context and instructions for AI agents and developers, following the project's standards and updated naming convention.